home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / file.n < prev    next >
Text File  |  1994-09-20  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. file(n)               Tcl Built-In Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      file - Manipulate file names and attributes
  12.  
  13. SYNOPSIS
  14.      file _o_p_t_i_o_n _n_a_m_e ?_a_r_g _a_r_g ...?
  15. _________________________________________________________________
  16.  
  17.  
  18. DESCRIPTION
  19.      This command provides several operations on a file's name or
  20.      attributes.  _N_a_m_e is the name of a file; if it starts with a
  21.      tilde, then tilde substitution is done before executing  the
  22.      command   (see  the  manual  entry  for  Tcl_TildeSubst  for
  23.      details).  _O_p_t_i_o_n indicates what to do with the  file  name.
  24.      Any unique abbreviation for _o_p_t_i_o_n is acceptable.  The valid
  25.      options are:
  26.  
  27.      file atime _n_a_m_e
  28.           Returns a decimal string giving the time at which  file
  29.           _n_a_m_e  was  last  accessed.  The time is measured in the
  30.           standard POSIX fashion as seconds from a fixed starting
  31.           time  (often  January  1,  1970).   If the file doesn't
  32.           exist or its access time  cannot  be  queried  then  an
  33.           error is generated.
  34.  
  35.      file dirname _n_a_m_e
  36.           Returns all of the characters in _n_a_m_e  up  to  but  not
  37.           including  the  last  slash character.  If there are no
  38.           slashes in _n_a_m_e then returns ``.''.  If the last  slash
  39.           in _n_a_m_e is its first character, then return ``/''.
  40.  
  41.      file executable _n_a_m_e
  42.           Returns 1 if file _n_a_m_e is  executable  by  the  current
  43.           user, 0 otherwise.
  44.  
  45.      file exists _n_a_m_e
  46.           Returns 1 if file _n_a_m_e exists and the current user  has
  47.           search  privileges for the directories leading to it, 0
  48.           otherwise.
  49.  
  50.      file extension _n_a_m_e
  51.           Returns all of the characters in _n_a_m_e after and includ-
  52.           ing  the  last dot in _n_a_m_e.  If there is no dot in _n_a_m_e
  53.           then returns the empty string.
  54.  
  55.      file isdirectory _n_a_m_e
  56.           Returns 1 if file _n_a_m_e is a directory, 0 otherwise.
  57.  
  58.      file isfile _n_a_m_e
  59.           Returns 1 if file _n_a_m_e is a regular file, 0 otherwise.
  60.  
  61.  
  62.  
  63. Tcl                                                             1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. file(n)               Tcl Built-In Commands
  71.  
  72.  
  73.  
  74.      file lstat _n_a_m_e _v_a_r_N_a_m_e
  75.           Same as stat option (see below) except uses  the  _l_s_t_a_t
  76.           kernel  call  instead of _s_t_a_t.  This means that if _n_a_m_e
  77.           refers to a symbolic link the information  returned  in
  78.           _v_a_r_N_a_m_e  is for the link rather than the file it refers
  79.           to.  On systems that don't support symbolic links  this
  80.           option behaves exactly the same as the stat option.
  81.  
  82.      file mtime _n_a_m_e
  83.           Returns a decimal string giving the time at which  file
  84.           _n_a_m_e  was  last  modified.  The time is measured in the
  85.           standard POSIX fashion as seconds from a fixed starting
  86.           time  (often  January  1,  1970).   If the file doesn't
  87.           exist or its modified time cannot be  queried  then  an
  88.           error is generated.
  89.  
  90.      file owned _n_a_m_e
  91.           Returns 1 if file _n_a_m_e is owned by the current user,  0
  92.           otherwise.
  93.  
  94.      file readable _n_a_m_e
  95.           Returns 1 if file _n_a_m_e is readable by the current user,
  96.           0 otherwise.
  97.  
  98.      file readlink _n_a_m_e
  99.           Returns the value of the symbolic link  given  by  _n_a_m_e
  100.           (i.e.  the  name  of  the  file it points to).  If _n_a_m_e
  101.           isn't a symbolic link or its value cannot be read, then
  102.           an  error  is  returned.  On systems that don't support
  103.           symbolic links this option is undefined.
  104.  
  105.      file rootname _n_a_m_e
  106.           Returns all of the characters in _n_a_m_e  up  to  but  not
  107.           including  the  last  ``.''  character in the name.  If
  108.           _n_a_m_e doesn't contain a dot, then returns _n_a_m_e.
  109.  
  110.      file size _n_a_m_e
  111.           Returns a decimal string giving the size of  file  _n_a_m_e
  112.           in bytes.  If the file doesn't exist or its size cannot
  113.           be queried then an error is generated.
  114.  
  115.      file stat  _n_a_m_e _v_a_r_N_a_m_e
  116.           Invokes the stat kernel call  on  _n_a_m_e,  and  uses  the
  117.           variable  given by _v_a_r_N_a_m_e to hold information returned
  118.           from the kernel call.  _V_a_r_N_a_m_e is treated as  an  array
  119.           variable,  and  the following elements of that variable
  120.           are set: atime, ctime,  dev,  gid,  ino,  mode,  mtime,
  121.           nlink,  size, type, uid.  Each element except type is a
  122.           decimal string with  the  value  of  the  corresponding
  123.           field  from  the  stat return structure; see the manual
  124.           entry for stat for  details  on  the  meanings  of  the
  125.           values.  The type element gives the type of the file in
  126.  
  127.  
  128.  
  129. Tcl                                                             2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. file(n)               Tcl Built-In Commands
  137.  
  138.  
  139.  
  140.           the same form returned by the command file type.   This
  141.           command returns an empty string.
  142.  
  143.      file tail _n_a_m_e
  144.           Returns all of the characters in _n_a_m_e  after  the  last
  145.           slash.  If _n_a_m_e contains no slashes then returns _n_a_m_e.
  146.  
  147.      file type _n_a_m_e
  148.           Returns a string giving the type of  file  _n_a_m_e,  which
  149.           will  be  one  of  file,  directory,  characterSpecial,
  150.           blockSpecial, fifo, link, or socket.
  151.  
  152.      file writable _n_a_m_e
  153.           Returns 1 if file _n_a_m_e is writable by the current user,
  154.           0 otherwise.
  155.  
  156.  
  157. KEYWORDS
  158.      attributes, directory, file, name, stat
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Tcl                                                             3
  196.  
  197.  
  198.  
  199.